Skip to content

[RES-1463] Document overwrite, digest pins, lifetime and limits in the user flow - #409

Merged
klemmster merged 2 commits into
masterfrom
docs/user-flow-lifetime-and-limits
Nov 12, 2026
Merged

klemmster merged 2 commits into
masterfrom
docs/user-flow-lifetime-and-limits

Conversation

@etiennechabert

Copy link
Copy Markdown
Contributor

Adds to docs/user-flow.md some Kangal behaviour that users only find out by trial and error:

  • Create: the test starts as soon as it's created, so list by tag before resubmitting after a lost response. The proxy answers 429 when it already has --max-load-tests tests creating or running.
  • Overwrite: what overwrite=false (400) and overwrite=true (deletes every test with the same test file, running ones included) do.
  • Tags: values are capped at 63 characters.
  • Custom images: they need ALLOWED_CUSTOM_IMAGES=true. A digest is recognised only without a tag and with at most two /; anything else, such as name:tag@sha256:<digest>, silently runs the default image.
  • Logs: k6 has no main process, so its logs are read per worker.
  • Lifetime: finished and errored tests are deleted after CLEANUP_THRESHOLD, taking their status and logs with them, while the report stays.
  • Limits: test files and test data are limited to 1 MiB (ConfigMaps), and envVars values are stored in plain text.

Each point was checked against the source on master: pkg/proxy/proxy.go (Create, GetLogs), pkg/proxy/request.go (getImage, unchanged since 1.7.1), pkg/kubernetes/apis/loadtest/v1/loadtest.go (maxTagLength), pkg/controller/loadtest.go (checkLoadTestLifeTimeExceeded), the backends' resources.go, and pkg/report/handler.go. Documentation only, no code changes.

🤖 Generated with Claude Code

…e user flow

- Creating a test starts it at once, and the proxy answers 429 at its
  limit of active tests.
- What overwrite does when a test with the same test file exists.
- Tag values are capped at 63 characters.
- Custom images need ALLOWED_CUSTOM_IMAGES; a digest is only recognised
  without a tag and with at most two '/', otherwise the default image
  runs without an error.
- k6 has no main process, so its logs are read per worker.
- Tests are deleted after CLEANUP_THRESHOLD, while their report stays.
- Files are limited to 1 MiB and envVars values are stored in plain text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@klemmster klemmster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice additions, I think this should make it easier to use.

@klemmster
klemmster merged commit 88e46a0 into master Nov 12, 2026
5 checks passed
@klemmster
klemmster deleted the docs/user-flow-lifetime-and-limits branch November 12, 2026 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants